Function Reference

_TS_ErrorText

Returns the full error message for an UDF function or the error/success message for the Task Scheduler API.

#Include <TaskScheduler.au3>
_TS_ErrorMessage($iErrorNumber[, $bPrefix = True])

Parameters

$iErrorNumber	Integer of the error returned by a function of this UDF or the Task Scheduler API
$bPrefix	[optional] True prefixes the error with functionname/errorname and errornumber (default = True)

Return Value

Success: If $bPrefix = True: FunctionName (ErrorNumber): ErrorText, else: ErrorText
Failure: Returns "" and sets @error:
301 - Specified error number could not be found

Remarks

The Task Scheduler APIs return error/success as an HRESULT value e.g:
$bPrefix = True: SCHED_S_TASK_NOT_SCHEDULED (0x00041305): One or more of the properties that are needed to run this task on a schedule have not been set.
$bPrefix = False: One or more of the properties that are needed to run this task on a schedule have not been set.
"S" as the second token of the APIs errorname denotes a success value, "E" an error value.
|
$bPrefix = True: ErrorNumber will be returned in hex notation (e.g. 0x00041305) if $iErrorNumber < 0

Related

Example

#Region ;**** Directives created by AutoIt3Wrapper_GUI ****
#AutoIt3Wrapper_Res_requestedExecutionLevel=asInvoker
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=y
#AutoIt3Wrapper_AU3Check_Parameters=-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7
#EndRegion ;**** Directives created by AutoIt3Wrapper_GUI ****

#include <TaskScheduler.au3>

Global $iError, $iExtended

; *****************************************************************************
; Connect to the Task Scheduler Service of a computer that doesn't exist
; *****************************************************************************
_TS_ErrorNotify(2)
Global $oService = _TS_Open("Dummy-Computer")
If @error <> 0 Then
$iError = @error
$iExtended = @extended
MsgBox($MB_ICONERROR, "Task Scheduler UDF - Full error information", "@error = " & $iError & ", @extended = 0x" & Hex($iExtended) & @CRLF & "============================" & @CRLF & @CRLF & _TS_ErrorText($iError))
EndIf

; *****************************************************************************
; Retrieve the message text for a HRESULT as returned by the Task Scheduler API.
; *****************************************************************************
$iError = 0x80041317 ; This returns an error message
MsgBox($MB_ICONERROR, "Task Scheduler UDF - Full error information", _TS_ErrorText($iError))
$iError = 0x00041301 ; This returns an success message
MsgBox($MB_ICONERROR, "Task Scheduler UDF - Full success information", _TS_ErrorText($iError, False))